Platform Explorer / Nuxeo Platform 2023.10

Extension point elasticSearchHints

In component org.nuxeo.elasticsearch.ElasticSearchComponent

Documentation

Extension point used to define the NXQL hints which enables the use of Elasticsearch operators. Must implement the ESHintQueryBuilder interface.

@see https://doc.nuxeo.com/nxdoc/nxql/#elasticsearch-nxql-hints to have the available ES hints.

Contribution Descriptors

  • Class: org.nuxeo.elasticsearch.config.ESHintQueryBuilderDescriptor

Existing Contributions

Contributions are presented in the same order as the registration order on this extension point. This order is displayed before the contribution name, in brackets.

  • nuxeo-elasticsearch-core-2023.10.13.jar /OSGI-INF/elasticsearch-hints-contrib.xml 
    <extension point="elasticSearchHints" target="org.nuxeo.elasticsearch.ElasticSearchComponent">
    <hint class="org.nuxeo.elasticsearch.hint.MatchESHintQueryBuilder" name="match"/>
    <hint class="org.nuxeo.elasticsearch.hint.MatchPhraseESHintQueryBuilder" name="match_phrase"/>
    <hint class="org.nuxeo.elasticsearch.hint.MatchPhrasePrefixESHintQueryBuilder" name="match_phrase_prefix"/>
    <hint class="org.nuxeo.elasticsearch.hint.MultiMatchESHintQueryBuilder" name="multi_match"/>
    <hint class="org.nuxeo.elasticsearch.hint.RegexESHintQueryBuilder" name="regex"/>
    <hint class="org.nuxeo.elasticsearch.hint.FuzzyESHintQueryBuilder" name="fuzzy"/>
    <hint class="org.nuxeo.elasticsearch.hint.WildcardESHintQueryBuilder" name="wildcard"/>
    <hint class="org.nuxeo.elasticsearch.hint.CommonESHintQueryBuilder" name="common"/>
    <hint class="org.nuxeo.elasticsearch.hint.QueryStringESHintQueryBuilder" name="query_string"/>
    <hint class="org.nuxeo.elasticsearch.hint.SimpleQueryStringESHintQueryBuilder" name="simple_query_string"/>
    <hint class="org.nuxeo.elasticsearch.hint.MoreLikeThisESHintQueryBuilder" name="more_like_this"/>
    <hint class="org.nuxeo.elasticsearch.hint.GeoBoundingBoxESHintQueryBuilder" name="geo_bounding_box"/>
    <hint class="org.nuxeo.elasticsearch.hint.GeoDistanceESHintQueryBuilder" name="geo_distance"/>
    <hint class="org.nuxeo.elasticsearch.hint.GeoShapeESHintQueryBuilder" name="geo_shape"/>
  </extension>
    (0) nuxeo-elasticsearch-core-2023.10.13.jar/OSGI-INF/elasticsearch-hints-contrib.xml   Override